home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 19 / CU Amiga Magazine's Super CD-ROM 19 (1998)(EMAP Images)(GB)[!][issue 1998-02].iso / CUCD / Online / hsc / examples / simple / README next >
Text File  |  1997-06-02  |  3KB  |  82 lines
  1. Simple Example Project
  2. ======================
  3.  
  4. This directory contains a small example project.
  5.  
  6. The sources are collected in "source_hsc/" and should be converted to
  7. "object_html/". This is the directory where the "browsable" data
  8. will be located.
  9.  
  10. This text assumes that you are in the CLI and your current directory
  11. is "[hsc]/examples/simple/source_hsc/", with "[hsc]" being the
  12. directory where you installed this package to.
  13.  
  14. Description of sources:
  15. -----------------------
  16.  
  17. main.hsc              the welcome page of this project
  18. stupid.hsc            a simple page that can be reached from "main"
  19. macro.hsc             contains some macro definitions and is
  20.                       included into all files
  21. hugo/                 a subdirectory, where all information about
  22.                       Hugo is collected
  23. hugo/hugo.hsc         some information about Hugo
  24. hugo/hugo.gif         a picture of Hugo
  25.  
  26. Setting up the object directory:
  27. --------------------------------
  28.  
  29. For every directory in the source-dir, a corresponding directory
  30. with the same name has to be created. This can be done via
  31.  
  32.     makedir /object_html/hugo
  33.  
  34. As the picture is of no real use in the source directory, you should
  35. move it to the object directory:
  36.  
  37.     rename hugo/hugo.gif /object_html/hugo/
  38.  
  39. Note that every file, that is not a hsc-source or include-file has to
  40. be located somewhere in the object directory. This especially concerns
  41. pictures, sounds and everything else that is linked, but not a hsc
  42. source file.
  43.  
  44. Starting the conversion:
  45. ------------------------
  46.  
  47. Now you are ready to start `make':
  48.  
  49.     make
  50.  
  51. Of course, you need to have a `make' command installed in your search
  52. path. See the main documentation where to obtain it.
  53.  
  54. After that, all html-objects in "object_html/" should be ready.
  55.  
  56. Note that there does not exist a "macro.html", because the there is
  57. no rule for this in the makefile. There is no rule necessary,
  58. because "macro.hsc" is never converted alone, but only included by
  59. the other files. Additionally, "macro.hsc" contains no readable text
  60. or tags.
  61.  
  62. Take a look at the "Makefile" to understand the basic concept of hsc.
  63.  
  64. Toubleshooting:
  65. ---------------
  66.  
  67. If make aborts with a message like
  68.  
  69.    *** unable to open `/object_html/hugo/hugo.html' for output:
  70.        No such file or directory
  71.  
  72. you forgot the call to `makedir' mentioned above.
  73.  
  74. If make aborts with a message like
  75.  
  76.    Makefile:31: *** missing separator.  Stop.
  77.  
  78. you are using a editor which replaces TABs by normal blanks. This is a
  79. good time to start browsing the documantation, section `Project
  80. Management/Make'...
  81.  
  82.